home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / ss / parser14.zip / PARSER.DOC next >
Text File  |  1992-02-28  |  15KB  |  356 lines
  1.                      SmartParser version 1.4
  2.                         February 28, 1992
  3.  
  4.          Copyright (c) 1990, 1992, Huntington Software 
  5.           9152 Brabham Drive, Huntington Beach CA 92646
  6.                        All Rights Reserved
  7.  
  8. INTRODUCTION
  9.  
  10. The SmartParser program PARSER.EXE converts ASCII report files
  11. into Lotus 1-2-3 spreadsheets without the need for using the
  12. Lotus /File Import or /Data Parse commands.  It reads a report
  13. file, parses the data into rows and columns containing labels and
  14. numbers, and creates a spreadsheet file in WKS format.  This
  15. spreadsheet can then be read directly by Lotus 1-2-3.
  16.  
  17. The program runs in two modes: Automatic, and Profile.  In
  18. automatic mode the program scans your report file looking for
  19. columns separated by blanks, and then parses the columns and
  20. creates a Lotus spreadsheet file.  In profile mode you must first
  21. define where the columns are located.  The program uses this
  22. information to parse the columns and is much more accurate.  A
  23. profile can be saved for any future conversions of the same
  24. report.  SmartParser is described in more detail in this file. 
  25.  
  26. THIS PROGRAM HAS BEEN THOROUGHLY TESTED, BUT IT IS IMPOSSIBLE TO
  27. TEST ALL POSSIBLE USES FOR THE PROGRAM, AND ERRORS IN CONVERSION
  28. CAN OCCUR.  Please check your spreadsheet for accuracy after using
  29. this product, particularly number cells.  In no event will
  30. Huntington Software be liable for any damages, including loss of
  31. data, lost profits, or any other incidental or consequential
  32. damages arising from the use of this product.  
  33.  
  34. LIMITED LICENSE 
  35.  
  36. This software is distributed on a "shareware" basis.  It is not
  37. free software, or in the public domain.  You are granted a
  38. license to use this copy of SmartParser for a free 30 day evaluation
  39. period.  If you continue to use SmartParser after the evaluation
  40. period, you must send a registration fee of $40 to Huntington
  41. Software to obtain a perpetual single-user license.  For your fee
  42. you will also be sent a diskette with the latest version of the
  43. program, and FREE UPGRADE to the next release when available.
  44.  
  45. You may give this program to others provided you follow these
  46. restrictions: The program file (PARSER.EXE) is not modified in
  47. any way, the documentation file is included (PARSER.DOC), and you
  48. disclose the legal requirement to register the software for use
  49. beyond the 30 day evaluation period.  This software program is
  50. owned by Huntington Software and is licensed for use to registered
  51. licensees.  You may not sell the program, but you may charge a
  52. modest fee to distribute the program on diskettes or electronic
  53. bulletin boards.
  54.  
  55. QUICK START
  56.  
  57. To install on a hard disk, simply copy the files into a directory,
  58. and make that the current directory (more on this later).  To demo
  59. SmartParser, you can run it from floppy or hard disk.  From the
  60. DOS prompt, type PARSER to start the program (PARSER.EXE).  Select
  61. "Smart Parse" from the main menu by pressing ENTER.  Then select
  62. the demo file PARSER.WID.  SmartParser will convert the Widget
  63. Sales Report to a spreadsheet named PARSER.WKS. 
  64.  
  65. Lotus 1-2-3 provides a "/File Import" command that will copy a
  66. report file into a spreadsheet, but each line of the report
  67. becomes a long label in column "A".  The Lotus 1-2-3 user can
  68. then use the "/Data Parse" command to identify and separate
  69. columns.  Although these commands work, they are awkward and
  70. time-consuming to use.  The goal of SmartParser is to save you
  71. time and automate this process - leaving you more time to get
  72. your real work done! 
  73.  
  74. "ASCII" FILES 
  75.  
  76. An "ASCII" file is one that contains no special word processing
  77. or database codes. This means the file contains only ASCII
  78. characters that can be printed on a printer, like letters,
  79. numbers, and a few codes like form-feed and carriage return. 
  80. Typically, this file would be a report downloaded from a mainframe,
  81. but it could also be a print file from another PC program that is
  82. directed to disk rather than the printer.  For example, in Lotus
  83. 1-2-3 if you use the /Print command and specify "File" an ASCII
  84. report file with the extension of "PRN" will be created for your
  85. spreadsheet report.  
  86.  
  87. Please note that your file should NOT be in "comma delimited"
  88. format required for the /File Import Numbers command.  The file
  89. should simply be the report as it would be printed on a printer. 
  90. SmartParser is intended for files that contain data in columns -
  91. such as typical financial reports.  
  92.  
  93. HARD DISK INSTALLATION
  94.  
  95. SmartParser can easily be installed on a hard disk.  The file
  96. PARSER.EXE can be copied into any directory in your DOS PATH. 
  97. The documentation file PARSER.DOC should be copied into your
  98. current working directory.  If you are not sure what
  99. directories are in your path (or what that even means), you can
  100. install SmartParser into the same directory with your Lotus 1-2-3
  101. program files and drivers.  The easiest way is:                   
  102.  
  103. 1  Start Lotus 1-2-3 as you usually do 
  104. 2  Type the /System command to get a DOS prompt          
  105. 3  Copy the files by typing:  COPY A:*.*
  106. 4  When copying is complete, type EXIT to return    
  107.  
  108. DIRECTORY SUPPORT 
  109.  
  110. Like Lotus 1-2-3, SmartParser can be set up to use a directory
  111. other than the current directory for reading report files and
  112. saving spreadsheet files.  Select "Directory" from the main menu. 
  113. Enter the default directory and/or disk drive as you would in the
  114. Lotus 1-2-3 /Worksheet Global Default Directory command.  To save
  115. the setup in a configuration file, select "Keep setup" from the
  116. menu and SmartParser will use the directory at startup whenever it
  117. is run.  The configuration file is named PARSER.CFG and will be
  118. saved in your current DOS directory.  
  119.  
  120. RUNNING SMARTPARSER 
  121.  
  122. SmartParser can be run by typing PARSER at the DOS prompt.  This
  123. can be done prior to running 1-2-3, or from the /System command if
  124. you are running 1-2-3.  SmartParser only needs 64K of available
  125. memory to run, and is not memory-resident.  Menu selections can be
  126. selected by highlighting your choice with the arrow keys and
  127. pressing enter, or by pressing the first letter of the command.  
  128.  
  129. To convert a report automatically, select "Smart Parse" from the
  130. main menu.  A file selection screen will appear.  Select the file
  131. to be converted with the arrow keys, and then press enter. 
  132. SmartParser will scan the file, and create a Lotus 1-2-3 spreadsheet
  133. in Lotus 1A format.  (This format can be used in other releases of
  134. Lotus 1-2-3 as well, including 2.1 and 3.0.)  The spreadsheet file
  135. name will consist of the report file with an extension of "WKS". 
  136. For example, a report file BUDGET.RPT will be converted to a file
  137. named BUDGET.WKS.  If the spreadsheet file already exists, it will
  138. be replaced.
  139.  
  140. To convert a report using a profile (location of columns) read the
  141. next section.  This is a much more accurate way of conversion and
  142. is HIGHLY RECOMMENDED.
  143.  
  144. RUNNING FROM DOS PROMPT OR BAT FILE
  145.  
  146. SmartParser can also be run from the DOS command line.  The
  147. opening screens and menu are bypassed.  This also allows running
  148. the program in a BAT file of DOS commands.
  149.  
  150.          PARSER  <report-filename>  <profile-filename>
  151.  
  152. Type PARSER followed by a space and the full file name (WITH
  153. EXTENSION) to be converted and the file selection screen will be
  154. bypassed.  SmartParser will use automatic mode to create a
  155. spreadsheet.
  156.  
  157. To use profile mode, use the second optional parameter.  Type the
  158. full name (WITH EXTENSION) after the report file name.  This will
  159. convert the report file using the profile file you specify.  The
  160. extension does not have to be S$P - but must be included.
  161. PROFILES
  162.  
  163. SmartParser will estimate column locations based on patterns in
  164. the data, but may get it wrong.  Complex reports are more prone to
  165. error than simple ones with lots of blanks between columns.  You
  166. can pick the columns yourself, and define them to SmartParser in
  167. profiles that are saved on disk.  A profile only needs to be
  168. created once, and can then be used whenever the report needs to be
  169. converted into Lotus 1-2-3.  (Assuming the data changes, but the
  170. report layout stays the same.)  The menu choices are:  "Create
  171. Profile", and "Use Profile". 
  172.  
  173. CREATE PROFILE
  174.  
  175. When you select this option, the file selection screen will
  176. appear.  Choose the report file you will be defining.  It will
  177. then be shown on the screen as a guide for selecting the column
  178. locations.  You can move around in the report with PgUp, PgDn, Up
  179. and Down arrow keys, and shift left or right 40 characters (1/2
  180. screen) with the TAB and Shift-TAB keys.  
  181.  
  182. To select column locations, use the Right and Left arrow keys to
  183. position the cursor at the beginning of each column.  When the
  184. cursor is positioned where you want, press ENTER.  A "*" will
  185. appear at the top to show where you want the column to be parsed. 
  186. If you change your mind, position the cursor on the "*" and press
  187. Delete to remove the setting.  Press "L" if you want to define a
  188. column that will ALWAYS be labels even if it contains numbers (for
  189. example, a column of part number).
  190.  
  191. TIP:  Remember that LOTUS right-justifies numbers, and left-
  192. justifies text.  You should try to place the * immediately AFTER
  193. numbers to show the start of the next column - and not right over
  194. the first digit of the number.  The settings in this example work
  195. for this data, and would also work for much larger numbers:
  196.  
  197. -------------------------------------------------------------
  198. *         *         *            *           *            *
  199.  
  200.                      ACME HARDWARE SALES REPORT 
  201.  
  202. PRODUCT        SALES      RETURNS       COST       PROFIT
  203.  
  204. HAMMERS         400            10         900         30 
  205. DRILLS           30             3         450         13 
  206. NAILS          1200            15         420         55 
  207.  
  208. ------------------------------------------------------------- 
  209. When you are finished, press ESC to exit the screen and save the
  210. profile.  It will use the report file name, and add an extension
  211. of S$P.  For example, the profile for SALES.RPT would be names
  212. SALES.S$P. 
  213.  
  214. USING PROFILES 
  215.  
  216. Select "Use Profile" from the main menu.  The file selection
  217. screen will appear.  Choose the report file you want to convert
  218. (NOT the profile name).  SmartParser will look for a profile file
  219. name consisting of the report file name with an extension of S$P. 
  220. It will then start converting the report using the profile
  221. settings.  
  222.  
  223. CREATING PROFILES MANUALLY
  224.  
  225. SmartParser profiles can also be created manually using any word
  226. processor that supports DOS or ASCII formats (no word processing
  227. special codes).  The files can even be created on a mainframe to
  228. match the report format and downloaded with the report files.  For
  229. some examples, you can create some profiles and then examine them
  230. with the DOS type command.
  231.  
  232. The first record must contain the following line (all in upper
  233. case) to identify the file as a SmartParser profile: 
  234.  
  235. SMARTPARSER COLUMN PROFILE
  236.  
  237. The next record uses a COLS= command to define column
  238. locations, where a, b, and c represent the location of columns A,
  239. B, and C.  These comma-delimited numbers are repeated for as many
  240. columns as needed.  (If you run out of room, the COLS= command can
  241. be repeated on additional lines.)
  242.  
  243. COLS=a,b,c 
  244.  
  245.  
  246. Here is an example of a profile SALES.S$P with columns located at
  247. 1,14,20,27, and 32: 
  248.  
  249. SMARTPARSER COLUMN PROFILE
  250. COLS=1,14,20
  251. COLS=27,32
  252.  
  253. As decribed above, the profile file name must consist of the
  254. report file name with an extension of S$P.  If you have defined a
  255. default directory, it must be in that directory.  
  256. WELCOME SCREEN
  257.  
  258. If you would rather not see the initial welcome screen with the
  259. countdown, you can eliminate it.  Use the following DOS command to
  260. set an "environmental variable" prior to running PARSER.  You can
  261. even add it to your autoexec.bat file.
  262.  
  263.                 SET SPINTRO=OFF
  264.  
  265.  
  266. FILES 
  267.  
  268. The following files are being distributed with SmartParser.  If
  269. you downloaded the product from a bulletin board or obtained it
  270. from a Shareware distribution service, please let us know if you
  271. are missing any so we can provide an update.  
  272.  
  273.   PARSER.EXE          The SmartParser program
  274.   PARSER.DOC          Documentation manual 
  275.   PARSER.REG          Registration form
  276.   PARSER.WID          Widgets demo report file 
  277.  
  278.  
  279. ACKNOWLEDGEMENTS
  280.  
  281. Lotus 1-2-3 is a trademark of Lotus Development Corporation.
  282.  
  283. QUESTIONS, COMMENTS, SUPPORT 
  284.  
  285. Please direct any questions, comments, and suggestions for
  286. improvements to me (the author) at the address below.  I'm
  287. extremely interested in knowing how to improve the software!
  288.  
  289. Better yet, please contact me on CompuServe at id: 72040,1640
  290.  
  291. We are not able to offer telephone support at this time, except
  292. for site licensees with a maintenance contract (for information on
  293. this please contact us).  For support, please write to this
  294. address, or send an E-mail message on CompuServe.  Replies will be
  295. made within 1 week.
  296.  
  297.             Steve Jackson
  298.             Huntington Software
  299.             9152 Brabham Drive
  300.             Huntington Beach CA 92646 
  301.  
  302.             CompuServe Id: 72040,1640
  303.  
  304.                         SmartParser 
  305.  
  306.  
  307.                       REGISTRATION FORM
  308.  
  309.  
  310. Remit to:                       
  311.             
  312.          Huntington Software              
  313.          9152 Brabham Drive
  314.          Huntington Beach, CA 92646 
  315.  
  316.  
  317. From: 
  318.  
  319. Name:    ______________________________________________________
  320.  
  321. Company: ______________________________________________________
  322.  
  323. Address: ______________________________________________________
  324.  
  325.          ______________________________________________________
  326.  
  327. City:    ______________________________ State: __  Zip: _______
  328.  
  329. Quantity                               Unit Price      Total 
  330.  
  331.  
  332.   ___    SmartParser                     $40.00      __________
  333.  
  334.  
  335. Shipping and Sales Tax will be paid by Huntington Software
  336.  
  337.  
  338. Disk format:      [  ] 3-1/2"    [  ] 5-1/4"
  339.  
  340. Where did you obtain the program?  ______________________________
  341.  
  342. Your CompuServe Id (optional):     ______________________________
  343.  
  344. What improvements would you like?  ______________________________
  345.  
  346. _________________________________________________________________
  347.  
  348. What other kind of programs would be of interest to you? 
  349.  
  350. _________________________________________________________________
  351.  
  352. Other Comments:
  353.  
  354.  
  355.  
  356. ver 1.4 February 28, 1992